Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Run plan tests in end to end configuration #17117

Merged
merged 13 commits into from
Dec 10, 2024
Merged

Run plan tests in end to end configuration #17117

merged 13 commits into from
Dec 10, 2024

Conversation

systay
Copy link
Collaborator

@systay systay commented Oct 30, 2024

Description

We’ve frequently encountered planner tests that assert faulty query plans, which would crash if executed directly on MySQL. This PR enhances testing by running these queries, with data, against both MySQL and Vitess, ensuring the results are consistent and correct across both systems.

Related Issue(s)

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

systay and others added 2 commits October 29, 2024 16:54
@systay
test wip: run plan tests end2end
31229d9 
Signed-off-by: Andres Taylor <[email protected]>
@frouioui
Add skip_e2e to the plan tests
ff82993 
Signed-off-by: Florent Poinsard <[email protected]>
@vitess-bot vitess-bot
Copy link
Contributor

vitess-bot bot commented Oct 30, 2024

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Oct 30, 2024
@systay systay added Component: Query Serving Type: Testing and removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Oct 30, 2024
@github-actions github-actions bot added this to the v22.0.0 milestone Oct 30, 2024
@arthurschreiber
Copy link
Contributor

Nice! This will be a great help in making sure we catch planner issues earlier. 👍

@harshit-gangal
add plan equality with tracing
7864e3a 
Signed-off-by: Harshit Gangal <[email protected]>
@harshit-gangal
added global test
a518157 
Signed-off-by: Harshit Gangal <[email protected]>
@harshit-gangal
added unsharded keyspace to the test
6be7923 
Signed-off-by: Harshit Gangal <[email protected]>
@harshit-gangal harshit-gangal force-pushed the e2e-plantests branch 3 times, most recently from 8b1aee2 to 27d8dc9 Compare December 4, 2024 16:28
@harshit-gangal
plan test to use valid vindexes
bc938cd 
Signed-off-by: Harshit Gangal <[email protected]>
@harshit-gangal
refactor: test file rename
25b73de 
Signed-off-by: Harshit Gangal <[email protected]>
@codecov Codecov
Copy link

codecov bot commented Dec 6, 2024 •
edited
Loading

Codecov Report

Attention: Patch coverage is 15.51724% with 98 lines in your changes missing coverage. Please review.

Project coverage is 67.45%. Comparing base (ab7b516) to head (c476d58).
Report is 15 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/vtgate/engine/plan_description.go 0.00% 92 Missing ⚠️
go/vt/vtgate/vindexes/lookup_cost.go 75.00% 6 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main   #17117      +/-   ##
==========================================
+ Coverage   67.41%   67.45%   +0.03%     
==========================================
  Files        1576     1578       +2     
  Lines      253417   253541     +124     
==========================================
+ Hits       170846   171028     +182     
+ Misses      82571    82513      -58

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@harshit-gangal harshit-gangal changed the title test: Run plan tests in end to end configuration Run plan tests in end to end configuration Dec 7, 2024
@harshit-gangal harshit-gangal marked this pull request as ready for review December 7, 2024 06:12
@harshit-gangal
added a todo comment
cc9d853 
Signed-off-by: Harshit Gangal <[email protected]>
@harshit-gangal
codegen
c476d58 
Signed-off-by: Harshit Gangal <[email protected]>
@systay
Copy link
Collaborator Author

systay commented Dec 9, 2024

Thank you @harshit-gangal for picking this up and running with it. It looks great now. I can't accept my own PR, but if I could, I would! 👍

frouioui
frouioui approved these changes Dec 9, 2024
View reviewed changes
Copy link
Member

@frouioui frouioui left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is good! Any plan on running more plan tests in E2E?

@harshit-gangal
Copy link
Member

harshit-gangal commented Dec 10, 2024 •
edited
Loading

This is good! Any plan on running more plan tests in E2E?

This should be done as and when the planner is modified.

@harshit-gangal harshit-gangal merged commit 2c2b8a4 into vitessio:main Dec 10, 2024
101 checks passed
@harshit-gangal harshit-gangal deleted the e2e-plantests branch December 10, 2024 05:38
@systay systay mentioned this pull request Dec 10, 2024
Merged
5 tasks
@harshit-gangal harshit-gangal mentioned this pull request Dec 13, 2024
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@frouioui frouioui frouioui approved these changes

@harshit-gangal harshit-gangal harshit-gangal approved these changes

@GuptaManan100 GuptaManan100 Awaiting requested review from GuptaManan100 GuptaManan100 is a code owner

@rohit-nayak-ps rohit-nayak-ps Awaiting requested review from rohit-nayak-ps rohit-nayak-ps is a code owner

@deepthi deepthi Awaiting requested review from deepthi deepthi is a code owner

@mattlord mattlord Awaiting requested review from mattlord mattlord is a code owner

@arthurschreiber arthurschreiber Awaiting requested review from arthurschreiber arthurschreiber is a code owner

Assignees

@systay systay

@harshit-gangal harshit-gangal

Labels
Component: Query Serving Type: Testing
Projects
None yet
Milestone
v22.0.0
Development

Successfully merging this pull request may close these issues.
4 participants
@systay @arthurschreiber @harshit-gangal @frouioui